package com.unittec.zk.provider.setting.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 数据结构属性注解。
 *
 * @author carver.gu
 * @since 1.0, Apr 11, 2010
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.FIELD})
public @interface SettingField {

    /**
     * JSON属性映射名称
     **/
    String value() default "";

    /**
     * 是否必填
     *
     * @return
     */
    boolean required() default false;

    /**
     * 测试数据
     *
     * @return
     */
    String example() default "";

    /**
     * 描述信息
     *
     * @return
     */
    String description() default "";

}
